Interactivity API: Fix context object proxy references #59553
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DAreRodz
added
[Type] Bug
DAreRodz
added
the
Backport to WP 6.7 Beta/RC
DAreRodz
requested review from
kevin940726,
Mamaduka,
ntwb,
nerrad,
ajitbohra and
luisherranz
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +67 B (0%) Total Size: 1.71 MB
ℹ️ View Unchanged
|
cbravobernal
deleted the
fix/interactivity-api-context-object-proxy-references
branch
|
It is my understanding that this PR ensures that the contract provided by the Interactivity API is maintained. Without this references to objects in context could change and this would be unexpected based on the terms of the API. Therefore this PR is critical to the proper functioning of the Interactivity API which is due to be stablised in WP 6.5. For this reason I believe this PR should be included during the RC period. |
|
I just cherry-picked this PR to the pick/wp-65-rc-2 branch to get it included in the next release: dcce36d |
getdave
pushed a commit
that referenced
this pull request
Mar 11, 2024
* Add failing test * Fix returned proxy reference * Add more reference tests * Fix assignment of context objects * Update comment * Update changelog Co-authored-by: DAreRodz <darerodz@git.wordpress.org> Co-authored-by: c4rl0sbr4v0 <cbravobernal@git.wordpress.org>
getdave
removed
the
Backport to WP 6.7 Beta/RC
getdave
added
the
Backported to WP Core
getdave
pushed a commit
that referenced
this pull request
Mar 12, 2024
* Add failing test * Fix returned proxy reference * Add more reference tests * Fix assignment of context objects * Update comment * Update changelog Co-authored-by: DAreRodz <darerodz@git.wordpress.org> Co-authored-by: c4rl0sbr4v0 <cbravobernal@git.wordpress.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Fixes a bug with context references not being preserved.
When reading a property from the context whose value is an object, the current implementation wraps that object with a
Proxyto handle context inheritance. That "proxification" happens every time the property is accessed, instantiating a newProxy, thus changing the returned reference.For instance, the following state getter accessing the context always returns false.
Why?
Context properties should allow storing references to other context objects. This is something that Interactive Block developers would expect.
How?
Using some
WeakMapinstances to keep track of the objects inside the context to always return the same proxy.